/* multiboot.h - Multiboot header file. */
/* Copyright (C) 1999,2003,2007,2008,2009  Free Software Foundation, Inc.
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy
 *  of this software and associated documentation files (the "Software"), to
 *  deal in the Software without restriction, including without limitation the
 *  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 *  sell copies of the Software, and to permit persons to whom the Software is
 *  furnished to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in
 *  all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL ANY
 *  DEVELOPER OR DISTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 *  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
 *  IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef MULTIBOOT_HEADER
#define MULTIBOOT_HEADER 1

/* Quantos bytes desde o início do arquivo que procura para o cabeçalho. */
#define MULTIBOOT_SEARCH 8192

/* O campo mágico deveria conter isso. */
#define MULTIBOOT_HEADER_MAGIC 0x1BADB002

/* Isto deve ser em %eax. */
#define MULTIBOOT_BOOTLOADER_MAGIC 0x2BADB002

/* Os bits na parte necessária do campo de sinalizadores que não suportamos. */
#define MULTIBOOT_UNSUPPORTED 0x0000fffc

/* Alinhamento de módulos de multiboot. */
#define MULTIBOOT_MOD_ALIGN 0x00001000

/* Alinhamento da estrutura de informação multiboot. */
#define MULTIBOOT_INFO_ALIGN 0x00000004

/* Flags set in the 'flags' member of the multiboot header. */

/* Alinhar todos os módulos de inicialização na página i386 (4KB) limites */
#define MULTIBOOT_PAGE_ALIGN 0x00000001

/* Deve passar informações de memória para SO. */
#define MULTIBOOT_MEMORY_INFO 0x00000002

/* Deve passar informações de vídeo para SO. */
#define MULTIBOOT_VIDEO_MODE 0x00000004

/* Este flag indica o uso dos campos de endereço no cabeçalho. */
#define MULTIBOOT_AOUT_KLUDGE 0x00010000

/* Flags to be set in the 'flags' member of the multiboot info structure. */

/* Há informações de memória básica inferior/superior? */
#define MULTIBOOT_INFO_MEMORY 0x00000001
/* Existe um conjunto de dispositivos de inicialização? */
#define MULTIBOOT_INFO_BOOTDEV 0x00000002
/* É a linha de comando definida? */
#define MULTIBOOT_INFO_CMDLINE 0x00000004
/* Existem módulos para fazer algo com? */
#define MULTIBOOT_INFO_MODS 0x00000008

/* Estes dois seguintes são mutuamente exclusivas */

/* Existe uma tabela de símbolos carregados? */
#define MULTIBOOT_INFO_AOUT_SYMS 0x00000010
/* xiste uma tabela de cabeçalho ELF seção? */
#define MULTIBOOT_INFO_ELF_SHDR 0X00000020

/* ---------------------------------------------- */

/* Existe um mapa de memória cheia? */
#define MULTIBOOT_INFO_MEM_MAP 0x00000040

/* Existe informação de drive? */
#define MULTIBOOT_INFO_DRIVE_INFO 0x00000080

/* Existe uma tabela de configuração? */
#define MULTIBOOT_INFO_CONFIG_TABLE 0x00000100

/* Existe um nome boot loader? */
#define MULTIBOOT_INFO_BOOT_LOADER_NAME 0x00000200

/* Existe uma tabela APM? */
#define MULTIBOOT_INFO_APM_TABLE 0x00000400

/* Há informações de vídeo? */
#define MULTIBOOT_INFO_VIDEO_INFO 0x00000800

#ifndef ASM_FILE

typedef unsigned short multiboot_uint16_t;
typedef unsigned int multiboot_uint32_t;
typedef unsigned long long multiboot_uint64_t;

struct multiboot_header {
	/* Deve ser MULTIBOOT_MAGIC - ver acima. */
	multiboot_uint32_t magic;

	/* Recurso flags. */
	multiboot_uint32_t flags;

	/* Os campos acima, mais este deve ser igual a 0 mod 2 ^ 32. */
	multiboot_uint32_t checksum;

	/* Estes são apenas válidas se MULTIBOOT_AOUT_KLUDGE está definido. */
	multiboot_uint32_t header_addr;
	multiboot_uint32_t load_addr;
	multiboot_uint32_t load_end_addr;
	multiboot_uint32_t bss_end_addr;
	multiboot_uint32_t entry_addr;

	/* Estes são apenas válidas se MULTIBOOT_VIDEO_MODE está definido. */
	multiboot_uint32_t mode_type;
	multiboot_uint32_t width;
	multiboot_uint32_t height;
	multiboot_uint32_t depth;
};

/* A tabela de símbolo para a.out. */
struct multiboot_aout_symbol_table {
	multiboot_uint32_t tabsize;
	multiboot_uint32_t strsize;
	multiboot_uint32_t addr;
	multiboot_uint32_t reserved;
};
typedef struct multiboot_aout_symbol_table multiboot_aout_symbol_table_t;

/* A tabela cabeçalho de seção para ELF. */
struct multiboot_elf_section_header_table {
	multiboot_uint32_t num;
	multiboot_uint32_t size;
	multiboot_uint32_t addr;
	multiboot_uint32_t shndx;
};
typedef struct multiboot_elf_section_header_table
		multiboot_elf_section_header_table_t;

struct multiboot_info {
	/* Multiboot informação do número da versão */
	multiboot_uint32_t flags;

	/* A memória disponível a partir do BIOS */
	multiboot_uint32_t mem_lower;
	multiboot_uint32_t mem_upper;

	/* Partição "root" */
	multiboot_uint32_t boot_device;

	/* Linha de comando do Kernel */
	multiboot_uint32_t cmdline;

	/* Lista de inicialização do módulo */
	multiboot_uint32_t mods_count;
	multiboot_uint32_t mods_addr;

	union {
		multiboot_aout_symbol_table_t aout_sym;
		multiboot_elf_section_header_table_t elf_sec;
	} u;

	/* Memory mapping buffer */
	multiboot_uint32_t mmap_length;
	multiboot_uint32_t mmap_addr;

	/* Drive Info buffer */
	multiboot_uint32_t drives_length;
	multiboot_uint32_t drives_addr;

	/* ROM configuration table */
	multiboot_uint32_t config_table;

	/* Boot Loader Name */
	multiboot_uint32_t boot_loader_name;

	/* APM table */
	multiboot_uint32_t apm_table;

	/* Video */
	multiboot_uint32_t vbe_control_info;
	multiboot_uint32_t vbe_mode_info;
	multiboot_uint16_t vbe_mode;
	multiboot_uint16_t vbe_interface_seg;
	multiboot_uint16_t vbe_interface_off;
	multiboot_uint16_t vbe_interface_len;
};
typedef struct multiboot_info multiboot_info_t;

struct multiboot_mmap_entry {
	multiboot_uint32_t size;
	multiboot_uint64_t addr;
	multiboot_uint64_t len;
#define MULTIBOOT_MEMORY_AVAILABLE              1
#define MULTIBOOT_MEMORY_RESERVED               2
	multiboot_uint32_t type;
}__attribute__((packed));
typedef struct multiboot_mmap_entry multiboot_memory_map_t;

struct multiboot_mod_list {
	/* A memória usada vai de bytes 'mod_start' para 'mod_end-1 "inclusiva */
	multiboot_uint32_t mod_start;
	multiboot_uint32_t mod_end;

	/* Linha de comando do módulo */
	multiboot_uint32_t cmdline;

	/* Padding para levá-la para 16 bytes (deve ser zero) */
	multiboot_uint32_t pad;
};
typedef struct multiboot_mod_list multiboot_module_t;

#endif /* ! ASM_FILE */

#endif /* ! MULTIBOOT_HEADER */
